User solutions authenticated API #23585

tleibovitz · 2023-04-17T13:03:18Z

ARM API Information (Control Plane)

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for this PR by answering the following questions:

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

…pecs

openapi-workflow-bot · 2023-04-17T13:03:22Z

Hi, @tleibovitz Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

openapi-pipeline-app · 2023-04-17T13:03:23Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️❌LintDiff: 1 Errors, 1 Warnings failed [Detail]

compared tags (via openapi-validator v2.1.2)	new version	base version
package-2023-03-01-preview	package-2023-03-01-preview(b7bb737)	default(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule	Message	Related RPC [For API reviewers]
`❌` TopLevelResourcesListBySubscription	The top-level resource 'Solution' does not have list by subscription operation, please add it. Location: Solutions/preview/2023-03-01-preview/solutions.json#L248	RPC-Get-V1-05
⚠️ PageableOperation	Based on the response model schema, operation 'Operations_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Solutions/preview/2023-03-01-preview/solutions.json#L153

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]

Validation passes for ServiceAPIReadinessTest.

Tag generated; Prod region: Not deployed; Canary region: Not deployed

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️CadlAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

️️✔️TypeSpec Validation succeeded [Detail] [Expand]

Validation passes for TypeSpec Validation.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2023-04-17T13:03:24Z

Swagger Generation Artifacts

️🔄ApiDocPreview inProgress [Detail]

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2023-04-17T13:03:25Z

Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

openapi-workflow-bot · 2023-04-17T13:12:24Z

Hi @tleibovitz, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

openapi-pipeline-app · 2023-04-18T12:23:50Z

Swagger pipeline restarted successfully, please wait for status update in this comment.

v-xuto · 2023-04-25T02:31:41Z

/azp run

azure-pipelines · 2023-04-25T02:31:50Z

Azure Pipelines successfully started running 1 pipeline(s).

v-xuto · 2023-04-25T02:50:18Z

@tleibovitz Please fix CI checks errors (LintDiff), you can refer to this comments or https://aka.ms/ci-fix on how to fix it.
Besides, does the previous version also have this error? If these two APIs are also implemented in this way, it is not recommended to fix it.

tleibovitz · 2023-04-25T09:28:06Z

@tleibovitz Please fix CI checks errors (LintDiff), you can refer to this comments or https://aka.ms/ci-fix on how to fix it. Besides, does the previous version also have this error? If these two APIs are also implemented in this way, it is not recommended to fix it.

@v-xuto - There is no subscription context in this PR. The resources are scoped to individual users across subs, RGs, tenants etc.

The two comments are referring to a case where the subscription scope is meaningful. I saw other specs with similar paths (and similar comments when running validation tools) on the repo.

WDYM "previous version"? This is the API's first version.

raych1 · 2023-04-25T10:22:03Z

@tleibovitz , let me know if this PR is ready to merge.

tleibovitz · 2023-04-27T09:14:04Z

@tleibovitz , let me know if this PR is ready to merge.

@raych1 I have added a minor change that fixes the examples. PR is ready to merge from my side

v-xuto · 2023-04-28T06:26:38Z

@raych1 Please help merge this PR.

tleibovitz · 2023-05-02T05:47:36Z

@raych1 Can you please assist with closing this PR? We are on tight schedule and it is blocking us

@chunyu3 @v-xuto Can you please help us get this PR merged? I can see that @raych1 is OOO until 03/05.

chunyu3 · 2023-05-04T06:23:22Z

hello @tleibovitz The ApiReadinessCheck failed which means that this api-version is not deployed. we have approved and labelled the approved-okToMerge. After the service is deployed, you can merge the PR. Thanks

tleibovitz · 2023-05-04T08:19:57Z

hello @tleibovitz The ApiReadinessCheck failed which means that this api-version is not deployed. we have approved and labelled the approved-okToMerge. After the service is deployed, you can merge the PR. Thanks

You mean the manifest deployment?

v-xuto · 2023-05-05T03:29:07Z

hello @tleibovitz The ApiReadinessCheck failed which means that this api-version is not deployed. we have approved and labelled the approved-okToMerge. After the service is deployed, you can merge the PR. Thanks

You mean the manifest deployment?

@chunyu3 Please help to answer the author's confusion.

chunyu3 · 2023-05-06T03:08:00Z

hello @tleibovitz The ApiReadinessCheck failed which means that this api-version is not deployed. we have approved and labelled the approved-okToMerge. After the service is deployed, you can merge the PR. Thanks

You mean the manifest deployment?

Yes.

ghost · 2023-05-21T16:03:04Z

Hi, @tleibovitz. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

tleibovitz · 2023-05-21T16:05:44Z

@chunyu3 The manifest deployment is done. Can we merge this pr now?

v-xuto · 2023-05-22T03:26:50Z

/azp run

azure-pipelines · 2023-05-22T03:27:00Z

Azure Pipelines successfully started running 1 pipeline(s).

tleibovitz added 2 commits April 17, 2023 15:38

first pr

cae8dbc

Merge branch 'main' of https://github.com/tleibovitz/azure-rest-api-s…

87a489f

…pecs

openapi-assignment-bot bot assigned chunyu3 Apr 17, 2023

AzureRestAPISpecReview added ARMReview CI-FixRequiredOnFailure resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Apr 17, 2023

raych1 assigned v-xuto Apr 18, 2023

tleibovitz added 9 commits April 18, 2023 11:34

prettier fix

4094308

fix ref

17857ae

response code

972466b

readme

628a94f

readme api version

b33f803

api version

3e03141

try fix avocado

326f1fc

try again

266bb1d

another one

1411d39

tleibovitz added 7 commits April 18, 2023 15:30

try to remove default tag

9f1a3ed

semantic validation

84108b1

operations

2783f6d

autorest

1f21478

a few more fixes to examples

ffe8061

save progress

30db697

fix all issues

6ded963

AzureRestAPISpecReview added the CI-FixRequiredOnFailure label Apr 24, 2023

pilor added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Apr 24, 2023

openapi-workflow-bot bot removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Apr 24, 2023

v-xuto self-requested a review April 25, 2023 10:08

v-xuto added the Approved-LintDiff label Apr 25, 2023

v-xuto approved these changes Apr 25, 2023

View reviewed changes

v-xuto added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label Apr 25, 2023

minor modification

b7bb737

openapi-workflow-bot bot added commitAfterSignedOff and removed Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates labels Apr 27, 2023

v-xuto added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label Apr 27, 2023

ghost added the no-recent-activity label May 21, 2023

ghost removed the no-recent-activity label May 21, 2023

chunyu3 merged commit efd49b8 into Azure:main May 22, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

User solutions authenticated API #23585

User solutions authenticated API #23585

tleibovitz commented Apr 17, 2023 •

edited

Loading

openapi-workflow-bot bot commented Apr 17, 2023

openapi-pipeline-app bot commented Apr 17, 2023 •

edited

Loading

openapi-pipeline-app bot commented Apr 17, 2023 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented Apr 17, 2023 •

edited

Loading

openapi-workflow-bot bot commented Apr 17, 2023

openapi-pipeline-app bot commented Apr 18, 2023 •

edited

Loading

v-xuto commented Apr 25, 2023

azure-pipelines bot commented Apr 25, 2023

v-xuto commented Apr 25, 2023 •

edited

Loading

tleibovitz commented Apr 25, 2023 •

edited

Loading

raych1 commented Apr 25, 2023

tleibovitz commented Apr 27, 2023

v-xuto commented Apr 28, 2023

tleibovitz commented May 2, 2023 •

edited

Loading

chunyu3 commented May 4, 2023

tleibovitz commented May 4, 2023

v-xuto commented May 5, 2023

chunyu3 commented May 6, 2023

ghost commented May 21, 2023

tleibovitz commented May 21, 2023

v-xuto commented May 22, 2023

azure-pipelines bot commented May 22, 2023

User solutions authenticated API #23585

User solutions authenticated API #23585

Conversation

tleibovitz commented Apr 17, 2023 • edited Loading

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Apr 17, 2023

openapi-pipeline-app bot commented Apr 17, 2023 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Apr 17, 2023 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Apr 17, 2023 • edited Loading

openapi-workflow-bot bot commented Apr 17, 2023

openapi-pipeline-app bot commented Apr 18, 2023 • edited Loading

v-xuto commented Apr 25, 2023

azure-pipelines bot commented Apr 25, 2023

v-xuto commented Apr 25, 2023 • edited Loading

tleibovitz commented Apr 25, 2023 • edited Loading

raych1 commented Apr 25, 2023

tleibovitz commented Apr 27, 2023

v-xuto commented Apr 28, 2023

tleibovitz commented May 2, 2023 • edited Loading

chunyu3 commented May 4, 2023

tleibovitz commented May 4, 2023

v-xuto commented May 5, 2023

chunyu3 commented May 6, 2023

ghost commented May 21, 2023

tleibovitz commented May 21, 2023

v-xuto commented May 22, 2023

azure-pipelines bot commented May 22, 2023

tleibovitz commented Apr 17, 2023 •

edited

Loading

openapi-pipeline-app bot commented Apr 17, 2023 •

edited

Loading

openapi-pipeline-app bot commented Apr 17, 2023 •

edited

Loading

openapi-pipeline-app bot commented Apr 17, 2023 •

edited

Loading

openapi-pipeline-app bot commented Apr 18, 2023 •

edited

Loading

v-xuto commented Apr 25, 2023 •

edited

Loading

tleibovitz commented Apr 25, 2023 •

edited

Loading

tleibovitz commented May 2, 2023 •

edited

Loading